package com.example.scaffold.user.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.example.scaffold.common.bean.PageResult;
import com.example.scaffold.user.bean.UserDTO;
import com.example.scaffold.user.bean.UserEditParam;
import com.example.scaffold.user.bean.UserQueryParam;
import com.example.scaffold.user.bean.UserVO;
import com.example.scaffold.user.entity.User;

/**
 * 用户服务接口
 * 遵循阿里手册：服务层命名规范，接口设计规范
 *
 * @author example
 */
public interface UserService extends IService<User> {

    /**
     * 根据ID查询用户
     *
     * @param id 用户ID
     * @return 用户信息
     */
    UserDTO getUserById(Long id);

    /**
     * 创建用户
     *
     * @param param 用户信息
     * @return 用户ID
     */
    Long createUser(UserEditParam param);

    /**
     * 更新用户
     *
     * @param id      用户ID
     * @param param 用户信息
     * @return 是否成功
     */
    boolean updateUser(Long id, UserEditParam param);

    /**
     * 删除用户
     *
     * @param id 用户ID
     * @return 是否成功
     */
    boolean deleteUser(Long id);

    /**
     * 根据属性查询用户
     * @param param
     * @return
     */
    PageResult<UserVO> listUser(UserQueryParam param);
}
    